docs: update & reorganize about users & sso & scim#1021
docs: update & reorganize about users & sso & scim#1021adela-bytebase wants to merge 12 commits intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Reorganizes the Administration docs around users/machine identities and clarifies SSO vs SCIM concepts, including introducing a dedicated Workload Identity section and a new Service Account page.
Changes:
- Updates
docs.jsonnavigation to surface Service Account and a new Workload Identity group under Administration → Security. - Adds new Workload Identity documentation (overview + GitHub Actions + GitLab CI/CD guides).
- Refactors Users & Groups and SSO overviews to be more focused and to better explain protocol/flow/provisioning.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/docs.json | Reorders Administration → Security navigation; adds Service Account + Workload Identity group |
| docs/administration/workload-identity/overview.mdx | New overview landing page for Workload Identity |
| docs/administration/workload-identity/github-actions.mdx | New GitHub Actions setup guide for Workload Identity |
| docs/administration/workload-identity/gitlab-ci.mdx | New GitLab CI/CD setup guide for Workload Identity |
| docs/administration/user-groups/overview.mdx | Narrows “User” definition; links out to Service Account and Workload Identity |
| docs/administration/sso/overview.mdx | Rewrites overview to separate protocols, flows, and SCIM provisioning guidance |
| docs/administration/sso/oidc.mdx | Adds pointer to dedicated Entra ID OIDC guide |
| docs/administration/sso/oidc-entra-id.mdx | Retitles + clarifies scope and cross-links to OAuth alternative |
| docs/administration/sso/idp-initiated.mdx | Condenses and clarifies IdP-initiated vs SP-initiated explanation |
| docs/administration/service-account.mdx | New Service Account page and comparison vs Workload Identity |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
Deployment failed with the following error: View Documentation: https://vercel.com/docs/accounts/team-members-and-roles |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 12 out of 12 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (2)
docs/administration/workload-identity/gitlab-ci.mdx:19
- The GitLab guide updates the suggested workload identity email prefix to
gitlab-ci-deploy, but the “Complete Example” later in this doc still setsWORKLOAD_IDENTITY_EMAILtogitlab-deploy@workload.bytebase.com. This is inconsistent and can cause copy/paste failures if readers create the identity using the earlier instructions. Update the complete example to use the same email/prefix as the rest of the page (or explain why it differs).
docs/administration/workload-identity/github-actions.mdx:89 - This doc now quotes
$RESPONSEwhen extractingaccessTokenin the first workflow snippet, but the later “Complete Example” section still usesecho $RESPONSE | jq ...andecho $RESPONSEwithout quotes. Since the response can contain spaces/newlines, those lines can break when copy/pasted. Please apply the same quoting in the later snippet for consistency and correctness.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
No description provided.